home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2004 #2 / Amiga Plus CD - 2004 - No. 02.iso / AmigaPlus / Tools / Development / AmigaTalk / help / boopsidocs / getscreenmode_gc.doc < prev    next >
Text File  |  2004-01-31  |  8KB  |  305 lines
  1. TABLE OF CONTENTS
  2.  
  3. getscreenmode.gadget/--datasheet--
  4. getscreenmode.gadget/GETSCREENMODE_GetClass
  5. getscreenmode.gadget/--datasheet--                                                                                                                                   getscreenmode.gadget/--datasheet--
  6.  
  7.    NAME
  8.        getscreenmode_gc -- create getscreenmode BOOPSI objects
  9.  
  10.    SUPERCLASS
  11.        gadgetclass
  12.  
  13.    REQUIRES
  14.        button.gadget
  15.  
  16.    DESCRIPTION
  17.        The getscreenmode gadget class is used to get screenmodes from a
  18.        screenmode requester in an easy and consistent way.  It consists of
  19.        two button gadgets, one read-only and one popscreenmode button,
  20.        that are used to select the screenmode and show the result.
  21.  
  22.        Advantages that this class provides:
  23.  
  24.        > Consistent behaviour and look in all applications using this class
  25.          instead of doing their own screenmode selection routines.
  26.  
  27.        > Easy to use.
  28.  
  29.  
  30.     METHODS
  31.        OM_NEW -- Passed to superclass, defaults set, then OM_SET. Children
  32.                  created.
  33.  
  34.        OM_SET -- Passed to superclass, custom tags set.
  35.  
  36.        OM_GET -- Custom tag returned or passed to superclass.
  37.  
  38.        OM_UPDATE -- Passed to superclass, options set then rendered.
  39.  
  40.        OM_DISPOSE -- Children disposed of, then passed to superclass.
  41.  
  42.        GM_RENDER -- Passed to superclass, then children are rendered.
  43.  
  44.        GM_HITTEST -- Overrides superclass, returns GMR_GADGETHIT if within
  45.                  the popscreenmode button.
  46.  
  47.        GM_HELPTEST -- Overrides superclass, returns GMR_HELPHIT if within
  48.                  the domain of the gadget.
  49.  
  50.        GM_GOACTIVE -- Passed to superclass, passed to popfile/drawer button.
  51.  
  52.        GM_HANDLEINPUT -- Overrides superclass, all input processed.
  53.  
  54.        GM_GOINACTIVE -- Passed to superclass, popfile/drawer button deactivated.
  55.  
  56.        GM_DOMAIN -- Returns GDOMAIN_MINIMUM and GDOMAIN_MAXIMUM dimensions.
  57.  
  58.        GM_KEYACTIVE -- Private method for keyboard control.
  59.  
  60.        GM_KEYINACTIVE -- Private method for keyboard control.
  61.  
  62.        GSM_REQUEST -- getscreenmode gadget method for invoking the screenmode requester.
  63.  
  64.     ATTRIBUTES
  65.        Most of these tags operate the same as the ASLSM_#? tags in ASL library.
  66.        See <asl.library/AslRequest> for detailed descriptions.
  67.  
  68.        GETSCREENMODE_TitleText (STRPTR)
  69.           Title of the screenmode requester.
  70.  
  71.           Default to none.
  72.  
  73.           Applicability is (OM_NEW, OM_SET).
  74.  
  75.        GETSCREENMODE_Height (WORD)
  76.           Height of the screenmode requester.
  77.  
  78.           Defaults to 200.
  79.  
  80.           Applicability is (OM_NEW, OM_SET, OM_GET).
  81.  
  82.        GETSCREENMODE_Width (WORD)
  83.           Width of the screenmode requester.
  84.  
  85.           Defaults to 300.
  86.  
  87.           Applicability is (OM_NEW, OM_SET, OM_GET).
  88.  
  89.        GETSCREENMODE_LeftEdge (WORD)
  90.           Left edge of the screenmode requester.
  91.  
  92.           Defaults to 30.
  93.  
  94.           Applicability is (OM_NEW, OM_SET, OM_GET).
  95.  
  96.        GETSCREENMODE_TopEdge (WORD)
  97.           Top edge of the screenmode requester.
  98.  
  99.           Defaults to 20.
  100.  
  101.           Applicability is (OM_NEW, OM_SET, OM_GET).
  102.  
  103.        GETSCREENMODE_DisplayID (ULONG)
  104.           Display id of screenmode.
  105.  
  106.           Defaults to 0 (LORES_KEY).
  107.  
  108.           Applicability is (OM_NEW, OM_SET, OM_GET, OM_NOTIFY).
  109.  
  110.        GETSCREENMODE_DisplayWidth (ULONG)
  111.           Display width.
  112.  
  113.           Defaults to 640.
  114.  
  115.           Applicability is (OM_NEW, OM_SET, OM_GET, OM_NOTIFY).
  116.  
  117.        GETSCREENMODE_DisplayHeight (ULONG)
  118.           Display height.
  119.  
  120.           Defaults to 200.
  121.  
  122.           Applicability is (OM_NEW, OM_SET, OM_GET, OM_NOTIFY).
  123.  
  124.        GETSCREENMODE_DisplayDepth (UWORD)
  125.           Display depth.
  126.  
  127.           Defaults to 2.
  128.  
  129.           Applicability is (OM_NEW, OM_SET, OM_GET, OM_NOTIFY).
  130.  
  131.        GETSCREENMODE_OverscanType (UWORD)
  132.           Type of overscan.
  133.  
  134.           Defaults to OSCAN_TEXT.
  135.  
  136.           Applicability is (OM_NEW, OM_SET, OM_GET, OM_NOTIFY).
  137.  
  138.        GETSCREENMODE_AutoScroll (BOOL)
  139.           Autoscroll setting.
  140.  
  141.           Defaults to TRUE.
  142.  
  143.           Applicability is (OM_NEW, OM_SET, OM_NOTIFY).
  144.  
  145.        GETSCREENMODE_InfoOpened (BOOL)
  146.           Info window initially opened? 
  147.  
  148.           Defaults to FALSE.
  149.  
  150.           Applicability is (OM_NEW, OM_SET).
  151.  
  152.        GETSCREENMODE_InfoLeftEdge (WORD)
  153.           Info window left edge.
  154.  
  155.           Defaults to 30.
  156.  
  157.           Applicability is (OM_NEW, OM_SET, OM_GET).
  158.  
  159.        GETSCREENMODE_InfoTopEdge (WORD)
  160.           Info window top edge.
  161.  
  162.           Defaults to 20.
  163.  
  164.           Applicability is (OM_NEW, OM_SET, OM_GET).
  165.  
  166.        GETSCREENMODE_DoWidth (BOOL)
  167.           Display Width gadget?
  168.  
  169.           Defaults to FALSE.
  170.  
  171.           Applicability is (OM_NEW, OM_SET).
  172.  
  173.        GETSCREENMODE_DoHeight (BOOL)
  174.           Display Height gadget?
  175.  
  176.           Defaults to FALSE.
  177.  
  178.           Applicability is (OM_NEW, OM_SET).
  179.  
  180.        GETSCREENMODE_DoDepth (BOOL)
  181.           Display Depth gadget?
  182.  
  183.           Defaults to FALSE.
  184.  
  185.           Applicability is (OM_NEW, OM_SET).
  186.  
  187.        GETSCREENMODE_DoOverscanType (BOOL)
  188.           Display Overscan Type gadget?
  189.  
  190.           Defaults to FALSE.
  191.  
  192.           Applicability is (OM_NEW, OM_SET).
  193.  
  194.        GETSCREENMODE_DoAutoScroll (BOOL)
  195.           Display AutoScroll gadget?
  196.  
  197.           Defaults to FALSE.
  198.  
  199.           Applicability is (OM_NEW, OM_SET).
  200.  
  201.        GETSCREENMODE_PropertyFlags (ULONG)
  202.           Must have these Property flags.
  203.  
  204.           Defaults to DIPF_IS_WB.
  205.  
  206.           Applicability is (OM_NEW, OM_SET).
  207.  
  208.        GETSCREENMODE_PropertyMask (ULONG)
  209.           Only these should be looked at.
  210.  
  211.           Defaults to DIPF_IS_WB.
  212.  
  213.           Applicability is (OM_NEW, OM_SET).
  214.  
  215.        GETSCREENMODE_MinWidth (ULONG)
  216.           Minimum display width to allow.
  217.  
  218.           Defaults to 16.
  219.  
  220.           Applicability is (OM_NEW, OM_SET).
  221.  
  222.        GETSCREENMODE_MaxWidth (ULONG)
  223.           Maximum display width to allow.
  224.  
  225.           Defaults to 16368.
  226.  
  227.           Applicability is (OM_NEW, OM_SET).
  228.  
  229.        GETSCREENMODE_MinHeight (ULONG)
  230.           Minimum display height to allow.
  231.  
  232.           Defaults to 16.
  233.  
  234.           Applicability is (OM_NEW, OM_SET).
  235.  
  236.        GETSCREENMODE_MaxHeight (ULONG)
  237.           Maximum display height to allow.
  238.  
  239.           Defaults to 16368.
  240.  
  241.           Applicability is (OM_NEW, OM_SET).
  242.  
  243.        GETSCREENMODE_MinDepth (ULONG)
  244.           Minimum display depth to allow.
  245.  
  246.           Defaults to 1.
  247.  
  248.           Applicability is (OM_NEW, OM_SET).
  249.  
  250.        GETSCREENMODE_MaxDepth (ULONG)
  251.           Maximum display depth to allow.
  252.  
  253.           Defaults to 24.
  254.  
  255.           Applicability is (OM_NEW, OM_SET).
  256.  
  257.        GETSCREENMODE_FilterFunc (struct Hook *)
  258.           Function to filter mode id's.
  259.  
  260.           Defaults to none.
  261.  
  262.           Applicability is (OM_NEW, OM_SET).
  263.  
  264.        GETSCREENMODE_CustomSMList (struct List *)
  265.           Exec list of struct DisplayMode.
  266.  
  267.           Defaults to none.
  268.  
  269.           Applicability is (OM_NEW, OM_SET).
  270. getscreenmode.gadget/GETSCREENMODE_GetClass                 getscreenmode.gadget/GETSCREENMODE_GetClass
  271.  
  272.    NAME
  273.        GETSCREENMODE_GetClass -- Gets the pointer to the screenmode 
  274.                                  requester class
  275.  
  276.    SYNOPSIS
  277.        getscreenmode_class = GETSCREENMODE_GetClass();
  278.        D0
  279.  
  280.        Class * GETSCREENMODE_GetClass( void );
  281.  
  282.    FUNCTION
  283.        Obtains the pointer to the getscreenmode gadget class for use with
  284.        NewObject().  This function always returns a valid pointer so
  285.        you do not need to check it.  The reason is that if the library
  286.        opens fine, then the pointer returned is already setup.  (Of course
  287.        this implies that if opening the library fails, you shouldn't be
  288.        calling this.)
  289.  
  290.        Note that this function does not create the class, that is done
  291.        when the class library is opened.
  292.  
  293.    INPUTS
  294.  
  295.    RESULT
  296.        getscreenmode_class - Pointer to the getscreenmode gadget class.
  297.  
  298.    EXAMPLE
  299.  
  300.    NOTES
  301.  
  302.    BUGS
  303.  
  304.    SEE ALSO
  305.